[NFC][analyzer] Update docs of CodeChecker --ctu-ast-mode #144901
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation of the cross translation unit analysis mentioned a
certain flag of `CodeChecker` (an external open source tool that can be
used to drive the static analysis), but the information about it was
obsolete: apparently the name of the flag, the names of the possible
values, and the default value were all changed.
Currently `CodeChecker analyze --help` displays this flag as
```
--ctu-ast-mode {load-from-pch,parse-on-demand}
Choose the way ASTs are loaded during CTU analysis. Only available if
CTU mode is enabled. Mode 'load-from-pch' generates PCH format
serialized ASTs during the 'collect' phase. Mode 'parse-on-demand'
only generates the invocations needed to parse the ASTs. Mode 'load-
from-pch' can use significant disk-space for the serialized ASTs,
while mode 'parse-on-demand' can incur some runtime CPU overhead in
the second phase of the analysis. (default: parse-on-demand)
```
and I tried to follow this in the commands that I adjusted.
Note that this documentation file probably contains other obsolete
details as well, but I didn't try to find or fix them.
llvmbot
added
clang
Member
|
@llvm/pr-subscribers-clang-static-analyzer-1 @llvm/pr-subscribers-clang Author: Donát Nagy (NagyDonat) ChangesThe documentation of the cross translation unit analysis mentioned a certain flag of Currently and I tried to follow this in the commands that I adjusted. Note that this documentation file probably contains other obsolete details as well, but I didn't try to find or fix them. Full diff: https://github.com/llvm/llvm-project/pull/144901.diff 1 Files Affected:
diff --git a/clang/docs/analyzer/user-docs/CrossTranslationUnit.rst b/clang/docs/analyzer/user-docs/CrossTranslationUnit.rst
index 700dac0a87064..a04b9f8c24e46 100644
--- a/clang/docs/analyzer/user-docs/CrossTranslationUnit.rst
+++ b/clang/docs/analyzer/user-docs/CrossTranslationUnit.rst
@@ -132,7 +132,7 @@ Once we have set up the `PATH` environment variable and we activated the python
.. code-block:: bash
- $ CodeChecker analyze --ctu compile_commands.json -o reports
+ $ CodeChecker analyze --ctu --ctu-ast-mode load-from-pch compile_commands.json -o reports
$ ls -F
compile_commands.json foo.cpp foo.cpp.ast main.cpp reports/
$ tree reports
@@ -318,7 +318,7 @@ Once we have set up the `PATH` environment variable and we activated the python
.. code-block:: bash
- $ CodeChecker analyze --ctu --ctu-ast-loading-mode on-demand compile_commands.json -o reports
+ $ CodeChecker analyze --ctu compile_commands.json -o reports
$ ls -F
compile_commands.json foo.cpp main.cpp reports/
$ tree reports
|
Contributor
Author
|
I'm also pinging @bruntib (a developer of CodeChecker) for a review (perhaps an informal one?). |
gamesh411
approved these changes
Jul 30, 2025
Contributor
gamesh411
left a comment
gamesh411
left a comment
There was a problem hiding this comment.
I can confirm that this is the most current version.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation of the cross translation unit analysis mentioned a certain flag of
CodeChecker(an external open source tool that can be used to drive the static analysis), but the information about it was obsolete: apparently the name of the flag, the names of the possible values, and the default value were all changed.Currently
CodeChecker analyze --helpdisplays this flag asand I tried to follow this in the commands that I adjusted.
Note that this documentation file probably contains other obsolete details as well, but I didn't try to find or fix them.